SureTax Returns API

GET Form Instance Generation Log

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint retrieves the generation log associated with a specific form instance. It allows clients to access detailed information about the process of generating the form, including any messages, warnings, or errors encountered during the generation process. This information can be valuable for troubleshooting, auditing, and ensuring the accuracy of generated forms.

OperationId: GET Form Instance Generation Log

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstanceGenerationLog

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

FormInstanceGenerationLogResponse

OVERVIEWEXAMPLE

Overview

FormInstanceGenerationLogResponse

Display Name	Field Name	Field Type
Data	data	array[FormInstanceGenerationLog]

FormInstanceGenerationLog

Display Name	Field Name	Field Type
Log	log	array[GenerationLog]

GenerationLog

Display Name	Field Name	Field Type
Message Type	messageType	string
Message	message	string
Element Id	elementId	string
Element Name	elementName	string
Attribute Id	attributeId	string
Attribute Name	attributeName	string

Example Response

{
  "data": [
    {
      "log": [
        {
          "messageType": "E",
          "message": "Invalid value at \u0027Tax Payer ID\u0027: \u0027123456789\u0027. Value must be 8 digits.",
          "elementId": "1",
          "elementName": "Tax Payer ID",
          "attributeId": "1",
          "attributeName": "ABC"
        }
      ]
    }
  ]
}

Response Codes

code	description
200	The API response contains the status for a deletion process. Success Response - 200 OK. The API will respond with the current status of the process.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstanceGenerationLog

Add Request Headers: